<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>hdcp1x: xhdcp1x_port.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">hdcp1x
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xhdcp1x__port_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xhdcp1x_port.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hdcp1x___port_phy_if_adaptor_s.html">XHdcp1x_PortPhyIfAdaptorS</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The typedef defines the HDCP port adaptor table.  <a href="struct_x_hdcp1x___port_phy_if_adaptor_s.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga031431383ebf79ac5230c51596872619"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga031431383ebf79ac5230c51596872619">XHDCP1X_PORT_H</a></td></tr>
<tr class="memdesc:ga031431383ebf79ac5230c51596872619"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; Prevent circular inclusions by using protection macros  <a href="group__hdcp1x.html#ga031431383ebf79ac5230c51596872619">More...</a><br/></td></tr>
<tr class="separator:ga031431383ebf79ac5230c51596872619"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga62b350f20404434a855f46c62ee888ed"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga62b350f20404434a855f46c62ee888ed">XHDCP1X_PORT_UINT_TO_BUF</a>(buf, uint, numbits)</td></tr>
<tr class="memdesc:ga62b350f20404434a855f46c62ee888ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro converts from an unsigned integer to a little endian formatted buffer.  <a href="group__hdcp1x.html#ga62b350f20404434a855f46c62ee888ed">More...</a><br/></td></tr>
<tr class="separator:ga62b350f20404434a855f46c62ee888ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0b4d815c1d172e921b83f3685d54012b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga0b4d815c1d172e921b83f3685d54012b">XHDCP1X_PORT_BUF_TO_UINT</a>(uint, buf, numbits)</td></tr>
<tr class="memdesc:ga0b4d815c1d172e921b83f3685d54012b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro converts from a little endian formatted buffer to an unsigned integer value.  <a href="group__hdcp1x.html#ga0b4d815c1d172e921b83f3685d54012b">More...</a><br/></td></tr>
<tr class="separator:ga0b4d815c1d172e921b83f3685d54012b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf15471088fda7450a5b6c24c5c65e8da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#gaf15471088fda7450a5b6c24c5c65e8da">XHDCP1X_PORT_BSET_IN_BUF</a>(buf, bitnum)&#160;&#160;&#160;buf[(bitnum) &gt;&gt; 3] |=  (1u &lt;&lt; ((bitnum) &amp; 0x07u));</td></tr>
<tr class="memdesc:gaf15471088fda7450a5b6c24c5c65e8da"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro sets a bit within a little endian formatted buffer.  <a href="group__hdcp1x.html#gaf15471088fda7450a5b6c24c5c65e8da">More...</a><br/></td></tr>
<tr class="separator:gaf15471088fda7450a5b6c24c5c65e8da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad2baf460af0b886a5b2aedcc3085049b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#gad2baf460af0b886a5b2aedcc3085049b">XHDCP1X_PORT_BCLR_IN_BUF</a>(buf, bitnum)&#160;&#160;&#160;buf[(bitnum) &gt;&gt; 3] &amp;= ~(1u &lt;&lt; ((bitnum) &amp; 0x07u));</td></tr>
<tr class="memdesc:gad2baf460af0b886a5b2aedcc3085049b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro clears a bit within a little endian formatted buffer.  <a href="group__hdcp1x.html#gad2baf460af0b886a5b2aedcc3085049b">More...</a><br/></td></tr>
<tr class="separator:gad2baf460af0b886a5b2aedcc3085049b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae20b7b34529b50d90577913851201bf7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#gae20b7b34529b50d90577913851201bf7">XHDCP1X_PORT_BTST_IN_BUF</a>(buf, bitnum)&#160;&#160;&#160;(buf[(bitnum) &gt;&gt; 3] &amp; (1u &lt;&lt; ((bitnum) &amp; 0x07u)))</td></tr>
<tr class="memdesc:gae20b7b34529b50d90577913851201bf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro tests a bit within a little endian formatted buffer.  <a href="group__hdcp1x.html#gae20b7b34529b50d90577913851201bf7">More...</a><br/></td></tr>
<tr class="separator:gae20b7b34529b50d90577913851201bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gab3390f77e705a54ca5639baa56743d3a"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_x_hdcp1x___port_phy_if_adaptor_s.html">XHdcp1x_PortPhyIfAdaptorS</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#gab3390f77e705a54ca5639baa56743d3a">XHdcp1x_PortPhyIfAdaptor</a></td></tr>
<tr class="memdesc:gab3390f77e705a54ca5639baa56743d3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The typedef defines the HDCP port adaptor table.  <a href="group__hdcp1x.html#gab3390f77e705a54ca5639baa56743d3a">More...</a><br/></td></tr>
<tr class="separator:gab3390f77e705a54ca5639baa56743d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga758e8028b33a9204cabc6b8327eacaf3"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga758e8028b33a9204cabc6b8327eacaf3">XHdcp1x_PortHandlerType</a> { <a class="el" href="group__hdcp1x.html#gga758e8028b33a9204cabc6b8327eacaf3a1763ad0694adf51c42870df78089ec87">XHDCP1X_PORT_HANDLER_AUTHENTICATE</a> = 1
 }</td></tr>
<tr class="memdesc:ga758e8028b33a9204cabc6b8327eacaf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef defines the different types of handlers that can be registered to service interrupt requests from the HDCP port instance.  <a href="group__hdcp1x.html#ga758e8028b33a9204cabc6b8327eacaf3">More...</a><br/></td></tr>
<tr class="separator:ga758e8028b33a9204cabc6b8327eacaf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf5f729774d507b92940336ef2112939a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__hdcp1x.html#gab3390f77e705a54ca5639baa56743d3a">XHdcp1x_PortPhyIfAdaptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#gaf5f729774d507b92940336ef2112939a">XHdcp1x_PortDetermineAdaptor</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf5f729774d507b92940336ef2112939a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function determines the adaptor for a specified port device.  <a href="group__hdcp1x.html#gaf5f729774d507b92940336ef2112939a">More...</a><br/></td></tr>
<tr class="separator:gaf5f729774d507b92940336ef2112939a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1f9860359eea1bd7989e76c11888734c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga1f9860359eea1bd7989e76c11888734c">XHdcp1x_PortSetCallback</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr, u32 HandlerType, <a class="el" href="group__hdcp1x.html#gadb148e6df96c874ba6a9cef6cd23921a">XHdcp1x_Callback</a> CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:ga1f9860359eea1bd7989e76c11888734c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs an asynchronous callback function for the given HandlerType:  <a href="group__hdcp1x.html#ga1f9860359eea1bd7989e76c11888734c">More...</a><br/></td></tr>
<tr class="separator:ga1f9860359eea1bd7989e76c11888734c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafe3971f3a49c69f3a316f3fab58fdf20"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#gafe3971f3a49c69f3a316f3fab58fdf20">XHdcp1x_PortEnable</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr)</td></tr>
<tr class="memdesc:gafe3971f3a49c69f3a316f3fab58fdf20"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables a port device.  <a href="group__hdcp1x.html#gafe3971f3a49c69f3a316f3fab58fdf20">More...</a><br/></td></tr>
<tr class="separator:gafe3971f3a49c69f3a316f3fab58fdf20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga152c8d8f9abdee612ce15f6e914a122a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga152c8d8f9abdee612ce15f6e914a122a">XHdcp1x_PortDisable</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga152c8d8f9abdee612ce15f6e914a122a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables a port device.  <a href="group__hdcp1x.html#ga152c8d8f9abdee612ce15f6e914a122a">More...</a><br/></td></tr>
<tr class="separator:ga152c8d8f9abdee612ce15f6e914a122a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1e24817724b0410a9b272343a0ef745"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#gaf1e24817724b0410a9b272343a0ef745">XHdcp1x_PortIsCapable</a> (const <a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf1e24817724b0410a9b272343a0ef745"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function queries a port device to determine if hdcp is supported.  <a href="group__hdcp1x.html#gaf1e24817724b0410a9b272343a0ef745">More...</a><br/></td></tr>
<tr class="separator:gaf1e24817724b0410a9b272343a0ef745"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41b5285a790690159dece6baa5afadf9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga41b5285a790690159dece6baa5afadf9">XHdcp1x_PortIsRepeater</a> (const <a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga41b5285a790690159dece6baa5afadf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function queries a port device to determine if it is connected to a repeater.  <a href="group__hdcp1x.html#ga41b5285a790690159dece6baa5afadf9">More...</a><br/></td></tr>
<tr class="separator:ga41b5285a790690159dece6baa5afadf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ddc37a110b704b91553dea3646d18e2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga4ddc37a110b704b91553dea3646d18e2">XHdcp1x_PortSetRepeater</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr, u8 RptrConf)</td></tr>
<tr class="memdesc:ga4ddc37a110b704b91553dea3646d18e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function set the REPEATER information in the connected device.  <a href="group__hdcp1x.html#ga4ddc37a110b704b91553dea3646d18e2">More...</a><br/></td></tr>
<tr class="separator:ga4ddc37a110b704b91553dea3646d18e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8865a6a7279587d2a439f603b78bf35c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga8865a6a7279587d2a439f603b78bf35c">XHdcp1x_PortGetRepeaterInfo</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr, u16 *InfoPtr)</td></tr>
<tr class="memdesc:ga8865a6a7279587d2a439f603b78bf35c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function retrieves the repeater information from the connected device.  <a href="group__hdcp1x.html#ga8865a6a7279587d2a439f603b78bf35c">More...</a><br/></td></tr>
<tr class="separator:ga8865a6a7279587d2a439f603b78bf35c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e36b9c8a021600e2c9e3766f94b6dc7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga6e36b9c8a021600e2c9e3766f94b6dc7">XHdcp1x_PortRead</a> (const <a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr, u8 Offset, void *Buf, u32 BufSize)</td></tr>
<tr class="memdesc:ga6e36b9c8a021600e2c9e3766f94b6dc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads a register from a HDCP port device.  <a href="group__hdcp1x.html#ga6e36b9c8a021600e2c9e3766f94b6dc7">More...</a><br/></td></tr>
<tr class="separator:ga6e36b9c8a021600e2c9e3766f94b6dc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga46da74febe033d53ef2420d318fd63b9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga46da74febe033d53ef2420d318fd63b9">XHdcp1x_PortWrite</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr, u8 Offset, const void *Buf, u32 BufSize)</td></tr>
<tr class="memdesc:ga46da74febe033d53ef2420d318fd63b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function writes a register within a HDCP port device.  <a href="group__hdcp1x.html#ga46da74febe033d53ef2420d318fd63b9">More...</a><br/></td></tr>
<tr class="separator:ga46da74febe033d53ef2420d318fd63b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e84960fab8e0598e3dc0ecffd7fa2dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hdcp1x.html#ga5e84960fab8e0598e3dc0ecffd7fa2dc">XHdcp1x_PortHandleInterrupt</a> (<a class="el" href="struct_x_hdcp1x.html">XHdcp1x</a> *InstancePtr, u32 IntCause)</td></tr>
<tr class="memdesc:ga5e84960fab8e0598e3dc0ecffd7fa2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This handles an interrupt generated by a HDCP port device.  <a href="group__hdcp1x.html#ga5e84960fab8e0598e3dc0ecffd7fa2dc">More...</a><br/></td></tr>
<tr class="separator:ga5e84960fab8e0598e3dc0ecffd7fa2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
